com.inscoper.nbo.AcquisitionSoftware¶

Represents the XML element AcquisitionSoftware. More...

Inherits from com.inscoper.nbo.Software_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	AcquisitionSoftware()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
AcquisitionSoftware	__internal_create(long cPtr, boolean own)
AcquisitionSoftware	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

	Name
	AcquisitionSoftware(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(AcquisitionSoftware obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.Software_Type

	Name
	Software_Type()
void	setID(LSID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(String value, boolean validate) Sets the value of the Name attribute.
void	setName(String value) Sets the value of the Name attribute.
String	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the Name attribute is present.
void	setVersion(String value, boolean validate) Sets the value of the Version attribute.
void	setVersion(String value) Sets the value of the Version attribute.
String	getVersion() Returns the value of the Version attribute.
void	resetVersion() Resets the Version attribute to an unset state.
boolean	hasVersion() Checks whether the Version attribute is present.
void	setDeveloper(String value, boolean validate) Sets the value of the Developer attribute.
void	setDeveloper(String value) Sets the value of the Developer attribute.
String	getDeveloper() Returns the value of the Developer attribute.
void	resetDeveloper() Resets the Developer attribute to an unset state.
boolean	hasDeveloper() Checks whether the Developer attribute is present.
void	setWebsiteURL(String value, boolean validate) Sets the value of the WebsiteURL attribute.
void	setWebsiteURL(String value) Sets the value of the WebsiteURL attribute.
String	getWebsiteURL() Returns the value of the WebsiteURL attribute.
void	resetWebsiteURL() Resets the WebsiteURL attribute to an unset state.
boolean	hasWebsiteURL() Checks whether the WebsiteURL attribute is present.
void	setPrimaryPublicationID(String value, boolean validate) Sets the value of the PrimaryPublicationID attribute.
void	setPrimaryPublicationID(String value) Sets the value of the PrimaryPublicationID attribute.
String	getPrimaryPublicationID() Returns the value of the PrimaryPublicationID attribute.
void	resetPrimaryPublicationID() Resets the PrimaryPublicationID attribute to an unset state.
boolean	hasPrimaryPublicationID() Checks whether the PrimaryPublicationID attribute is present.
void	setOpenSource(boolean value, boolean validate) Sets the value of the OpenSource attribute.
void	setOpenSource(boolean value) Sets the value of the OpenSource attribute.
boolean	getOpenSource() Returns the value of the OpenSource attribute.
void	resetOpenSource() Resets the OpenSource attribute to an unset state.
boolean	hasOpenSource() Checks whether the OpenSource attribute is present.
void	setMacro(boolean value, boolean validate) Sets the value of the Macro attribute.
void	setMacro(boolean value) Sets the value of the Macro attribute.
boolean	getMacro() Returns the value of the Macro attribute.
void	resetMacro() Resets the Macro attribute to an unset state.
boolean	hasMacro() Checks whether the Macro attribute is present.
void	setBuild(String value, boolean validate) Sets the value of the Build attribute.
void	setBuild(String value) Sets the value of the Build attribute.
String	getBuild() Returns the value of the Build attribute.
void	resetBuild() Resets the Build attribute to an unset state.
boolean	hasBuild() Checks whether the Build attribute is present.
void	setPatch(String value, boolean validate) Sets the value of the Patch attribute.
void	setPatch(String value) Sets the value of the Patch attribute.
String	getPatch() Returns the value of the Patch attribute.
void	resetPatch() Resets the Patch attribute to an unset state.
boolean	hasPatch() Checks whether the Patch attribute is present.
void	setReleaseDate(String value, boolean validate) Sets the value of the ReleaseDate attribute.
void	setReleaseDate(String value) Sets the value of the ReleaseDate attribute.
String	getReleaseDate() Returns the value of the ReleaseDate attribute.
void	resetReleaseDate() Resets the ReleaseDate attribute to an unset state.
boolean	hasReleaseDate() Checks whether the ReleaseDate attribute is present.
void	setLanguage(String value, boolean validate) Sets the value of the Language attribute.
void	setLanguage(String value) Sets the value of the Language attribute.
String	getLanguage() Returns the value of the Language attribute.
void	resetLanguage() Resets the Language attribute to an unset state.
boolean	hasLanguage() Checks whether the Language attribute is present.
void	setSoftwareModuleRef_List(SoftwareModuleRefVector value, boolean validate) Sets the list of SoftwareModuleRef elements.
void	setSoftwareModuleRef_List(SoftwareModuleRefVector value) Sets the list of SoftwareModuleRef elements.
SoftwareModuleRefVector	getSoftwareModuleRef_List() Returns the list of SoftwareModuleRef elements.
void	addToSoftwareModuleRef_List(SoftwareModuleRef value, boolean validate) Adds a new SoftwareModuleRef element to this object.
void	addToSoftwareModuleRef_List(SoftwareModuleRef value) Adds a new SoftwareModuleRef element to this object.
void	clearSoftwareModuleRef_List() Clear the list of SoftwareModuleRef.
void	setAnnotationRef_List(AnnotationRefVector value, boolean validate) Sets the list of AnnotationRef elements.
void	setAnnotationRef_List(AnnotationRefVector value) Sets the list of AnnotationRef elements.
AnnotationRefVector	getAnnotationRef_List() Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(AnnotationRef value, boolean validate) Adds a new AnnotationRef element to this object.
void	addToAnnotationRef_List(AnnotationRef value) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
StringSet	getNameAllowedValues() Returns the allowed values for this attribut.
StringSet	getVersionAllowedValues() Returns the allowed values for this attribut.
StringSet	getDeveloperAllowedValues() Returns the allowed values for this attribut.
StringSet	getWebsiteURLAllowedValues() Returns the allowed values for this attribut.
StringSet	getPrimaryPublicationIDAllowedValues() Returns the allowed values for this attribut.
StringSet	getBuildAllowedValues() Returns the allowed values for this attribut.
StringSet	getPatchAllowedValues() Returns the allowed values for this attribut.
StringSet	getReleaseDateAllowedValues() Returns the allowed values for this attribut.
StringSet	getLanguageAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.Software_Type

	Name
	Software_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.AcquisitionSoftware;

Represents the XML element AcquisitionSoftware.

This element represents a commercial, or open-source Software, script, macro, plugin or module utilized for driving this Instrument during Image Acquisition.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.Software_Type.delete

function AcquisitionSoftware¶

public AcquisitionSoftware()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.Software_Type.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.Software_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.Software_Type.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.Software_Type.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.Software_Type.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Software_Type.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.Software_Type.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Software_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.Software_Type.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Software_Type.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.Software_Type.fromXmlFile

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Software_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.Software_Type.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.Software_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.Software_Type.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.Software_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.Software_Type.toXmlString

function __internal_create¶

public static AcquisitionSoftware __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.Software_Type.__internal_create

function fromBase¶

public static AcquisitionSoftware fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.Software_Type.fromBase

Protected Functions Documentation¶

function AcquisitionSoftware¶

protected AcquisitionSoftware(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.Software_Type.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.Software_Type.finalize

function getCPtr¶

protected static long getCPtr(
    AcquisitionSoftware obj
)

Updated on 2026-06-22 at 17:06:23 +0200